<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>Retro 2012: Retro.ViewModel.RetroViewModel Class Reference</title>

<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css" />

<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
  $(document).ready(function() { searchBox.OnSelectItem(0); });
</script>

</head>
<body>
<div id="top"><!-- do not remove this div! -->


<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  
  <td id="projectlogo"><img alt="Logo" src="retro.png"/></td>
  
  
  <td style="padding-left: 0.5em;">
   <div id="projectname">Retro 2012
   &#160;<span id="projectnumber">v2.3</span>
   </div>
   <div id="projectbrief">Clustering, Visualization, Transcription &amp; Typographic studies Software</div>
  </td>
  
  
  
 </tr>
 </tbody>
</table>
</div>

<!-- Generated by Doxygen 1.7.5.1 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="namespaces.html"><span>Packages</span></a></li>
      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
          </span>
        </div>
      </li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
      <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
      <li><a href="inherits.html"><span>Class&#160;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
    </ul>
  </div>
  <div id="nav-path" class="navpath">
    <ul>
      <li class="navelem"><a class="el" href="a00160.html">Retro</a>      </li>
      <li class="navelem"><a class="el" href="a00167.html">ViewModel</a>      </li>
      <li class="navelem"><a class="el" href="a00046.html">RetroViewModel</a>      </li>
    </ul>
  </div>
</div>
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#properties">Properties</a>  </div>
  <div class="headertitle">
<div class="title">Retro.ViewModel.RetroViewModel Class Reference</div>  </div>
</div>
<div class="contents">
<!-- doxytag: class="Retro::ViewModel::RetroViewModel" -->
<p>Define the <a class="el" href="a00167.html">ViewModel</a> Element of <a class="el" href="a00160.html">Retro</a> in the MVVM architectural pattern.  
 <a href="a00046.html#details">More...</a></p>

<p><a href="a00239.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00046.html#a7ec52b404d6490b05470013771c6612e">RetroViewModel</a> ()</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Default Constructor.  <a href="#a7ec52b404d6490b05470013771c6612e"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00046.html#a65719837646a600ea3de59a0b027dd09">NewProject</a> (String projectName, String agoraProjectFile)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Create a new <a class="el" href="a00160.html">Retro</a> project.  <a href="#a65719837646a600ea3de59a0b027dd09"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">ReturnValues.OpenProject&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00046.html#a3df4e9da4399894341756ca08b5891be">OpenProject</a> (String filepath)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Load an existing <a class="el" href="a00160.html">Retro</a> project.  <a href="#a3df4e9da4399894341756ca08b5891be"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00046.html#a5ba10d5450d9a607f1c2d3b9ffce1b7a">SaveProject</a> (String filepath)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Save the current project.  <a href="#a5ba10d5450d9a607f1c2d3b9ffce1b7a"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00046.html#a8c3a1ee257a3a2d03c24533e08cc3851">CloseProject</a> ()</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Close the current project.  <a href="#a8c3a1ee257a3a2d03c24533e08cc3851"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00046.html#aabd29d6bde8f4ddd917867f92e70ad38">ExportAsAlto</a> (<a class="el" href="a00020.html">DynamicSplashScreenNotification</a> dynamicSplashScreenNotification)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Export Transcription as Alto.  <a href="#aabd29d6bde8f4ddd917867f92e70ad38"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00046.html#a81bb77bc54025b6da0fb134ecc36f176">LoadClusters</a> (bool bIllustrationClustering)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Load clusters entities of the current project.  <a href="#a81bb77bc54025b6da0fb134ecc36f176"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">List&lt; <a class="el" href="a00013.html">Cluster</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00046.html#ac50606e668bcf41db2522caf3cb61585">GetClusters</a> ()</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the list of clusters of the current project.  <a href="#ac50606e668bcf41db2522caf3cb61585"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00046.html#a857bb13802b36c2220ff25b4d9fbc3f4">ClearClustersList</a> ()</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Clear current list of clusters.  <a href="#a857bb13802b36c2220ff25b4d9fbc3f4"></a><br/></td></tr>
<tr><td colspan="2"><h2><a name="properties"></a>
Properties</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00045.html">RetroProject</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00046.html#adc386fd3f4bd2103893ecc07fe98ea9c">RetroInstance</a><code> [get, set]</code></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Instance of the current used RetroProject.  <a href="#adc386fd3f4bd2103893ecc07fe98ea9c"></a><br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Define the <a class="el" href="a00167.html">ViewModel</a> Element of <a class="el" href="a00160.html">Retro</a> in the MVVM architectural pattern. </p>
</div><hr/><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a7ec52b404d6490b05470013771c6612e"></a><!-- doxytag: member="Retro::ViewModel::RetroViewModel::RetroViewModel" ref="a7ec52b404d6490b05470013771c6612e" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">Retro.ViewModel.RetroViewModel.RetroViewModel </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Default Constructor. </p>

</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a857bb13802b36c2220ff25b4d9fbc3f4"></a><!-- doxytag: member="Retro::ViewModel::RetroViewModel::ClearClustersList" ref="a857bb13802b36c2220ff25b4d9fbc3f4" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void Retro.ViewModel.RetroViewModel.ClearClustersList </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Clear current list of clusters. </p>

</div>
</div>
<a class="anchor" id="a8c3a1ee257a3a2d03c24533e08cc3851"></a><!-- doxytag: member="Retro::ViewModel::RetroViewModel::CloseProject" ref="a8c3a1ee257a3a2d03c24533e08cc3851" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void Retro.ViewModel.RetroViewModel.CloseProject </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Close the current project. </p>

</div>
</div>
<a class="anchor" id="aabd29d6bde8f4ddd917867f92e70ad38"></a><!-- doxytag: member="Retro::ViewModel::RetroViewModel::ExportAsAlto" ref="aabd29d6bde8f4ddd917867f92e70ad38" args="(DynamicSplashScreenNotification dynamicSplashScreenNotification)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void Retro.ViewModel.RetroViewModel.ExportAsAlto </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="a00020.html">DynamicSplashScreenNotification</a>&#160;</td>
          <td class="paramname"><em>dynamicSplashScreenNotification</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Export Transcription as Alto. </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table class="params">
    <tr><td class="paramname">dynamicSplashScreenNotification</td><td>Dynamic Splashscreen Notification</td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="ac50606e668bcf41db2522caf3cb61585"></a><!-- doxytag: member="Retro::ViewModel::RetroViewModel::GetClusters" ref="ac50606e668bcf41db2522caf3cb61585" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">List&lt;<a class="el" href="a00013.html">Cluster</a>&gt; Retro.ViewModel.RetroViewModel.GetClusters </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Get the list of clusters of the current project. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>List of clusters</dd></dl>

</div>
</div>
<a class="anchor" id="a81bb77bc54025b6da0fb134ecc36f176"></a><!-- doxytag: member="Retro::ViewModel::RetroViewModel::LoadClusters" ref="a81bb77bc54025b6da0fb134ecc36f176" args="(bool bIllustrationClustering)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void Retro.ViewModel.RetroViewModel.LoadClusters </td>
          <td>(</td>
          <td class="paramtype">bool&#160;</td>
          <td class="paramname"><em>bIllustrationClustering</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Load clusters entities of the current project. </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table class="params">
    <tr><td class="paramname">bIllustrationClustering</td><td>Indicate if we considerate illustration clusters</td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="a65719837646a600ea3de59a0b027dd09"></a><!-- doxytag: member="Retro::ViewModel::RetroViewModel::NewProject" ref="a65719837646a600ea3de59a0b027dd09" args="(String projectName, String agoraProjectFile)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void Retro.ViewModel.RetroViewModel.NewProject </td>
          <td>(</td>
          <td class="paramtype">String&#160;</td>
          <td class="paramname"><em>projectName</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">String&#160;</td>
          <td class="paramname"><em>agoraProjectFile</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Create a new <a class="el" href="a00160.html">Retro</a> project. </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table class="params">
    <tr><td class="paramname">projectName</td><td>Name of the current project</td></tr>
    <tr><td class="paramname">agoraProjectFile</td><td>Agora project file</td></tr>
  </table>
  </dd>
</dl>

<p><div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="a00046_a65719837646a600ea3de59a0b027dd09_cgraph.png" border="0" usemap="#a00046_a65719837646a600ea3de59a0b027dd09_cgraph" alt=""/></div>
<map name="a00046_a65719837646a600ea3de59a0b027dd09_cgraph" id="a00046_a65719837646a600ea3de59a0b027dd09_cgraph">
<area shape="rect" id="node3" href="a00045.html#a2a01a3f8bfa8fece8cb63c358b5a1939" title="Create a new Retro project." alt="" coords="341,5,581,32"/></map>
</div>
</p>

</div>
</div>
<a class="anchor" id="a3df4e9da4399894341756ca08b5891be"></a><!-- doxytag: member="Retro::ViewModel::RetroViewModel::OpenProject" ref="a3df4e9da4399894341756ca08b5891be" args="(String filepath)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">ReturnValues.OpenProject Retro.ViewModel.RetroViewModel.OpenProject </td>
          <td>(</td>
          <td class="paramtype">String&#160;</td>
          <td class="paramname"><em>filepath</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Load an existing <a class="el" href="a00160.html">Retro</a> project. </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table class="params">
    <tr><td class="paramname">filepath</td><td>Path of the project file</td></tr>
  </table>
  </dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>ReturnValues.OpenProject value</dd></dl>

<p><div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="a00046_a3df4e9da4399894341756ca08b5891be_cgraph.png" border="0" usemap="#a00046_a3df4e9da4399894341756ca08b5891be_cgraph" alt=""/></div>
<map name="a00046_a3df4e9da4399894341756ca08b5891be_cgraph" id="a00046_a3df4e9da4399894341756ca08b5891be_cgraph">
<area shape="rect" id="node3" href="a00045.html#af1afbcafd3c475a4fdc5ee492e1fd1c3" title="Open an existing Retro project." alt="" coords="350,5,597,32"/></map>
</div>
</p>

</div>
</div>
<a class="anchor" id="a5ba10d5450d9a607f1c2d3b9ffce1b7a"></a><!-- doxytag: member="Retro::ViewModel::RetroViewModel::SaveProject" ref="a5ba10d5450d9a607f1c2d3b9ffce1b7a" args="(String filepath)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void Retro.ViewModel.RetroViewModel.SaveProject </td>
          <td>(</td>
          <td class="paramtype">String&#160;</td>
          <td class="paramname"><em>filepath</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Save the current project. </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table class="params">
    <tr><td class="paramname">filepath</td><td>Path of the project file</td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<hr/><h2>Property Documentation</h2>
<a class="anchor" id="adc386fd3f4bd2103893ecc07fe98ea9c"></a><!-- doxytag: member="Retro::ViewModel::RetroViewModel::RetroInstance" ref="adc386fd3f4bd2103893ecc07fe98ea9c" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="a00045.html">RetroProject</a> Retro.ViewModel.RetroViewModel.RetroInstance<code> [get, set]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Instance of the current used RetroProject. </p>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="a00144.html">RetroViewModel.cs</a></li>
</ul>
</div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Properties</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Events</a></div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>



<hr class="footer"/><address class="footer"><small>
Generated on Fri Dec 7 2012 18:27:17 for Retro 2012 by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.7.5.1
</small></address>

</body>
</html>
